feat: reusable Sphinx docs-build workflow (warning-baseline gated)#48
Merged
Conversation
The RTD hygiene census (PyAutoLabs/PyAutoFit#1341) found no PyAuto library builds its docs pre-merge: ReadTheDocs runs with fail_on_warning: false and there is no CI docs job, so broken API pages rot silently. This adds the Heart-owned reusable docs-build workflow, mirroring lib-tests.yml mechanics (package→repo/deps mapping, sibling-branch-aware dependency clones, source installs). Library repos call it thinly from .github/workflows/docs.yml; the build fails when the Sphinx warning count regresses past the repo's docs/sphinx_warning_baseline.txt (missing file = 0 = strict). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GziFkivBHz1d11eFYUszmy
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the Heart-owned reusable
docs-build.ymlworkflow — the docs analogue oflib-tests.yml. The RTD hygiene census (PyAutoLabs/PyAutoFit#1341) found no PyAuto library builds its Sphinx docs pre-merge (ReadTheDocs runsfail_on_warning: false, no CI docs job anywhere), so broken API pages rot silently. Library repos call this thinly from.github/workflows/docs.yml; the build fails when the Sphinx warning count regresses past the repo's committeddocs/sphinx_warning_baseline.txt(missing file = 0 = strict). Mechanics mirrorlib-tests.yml: package→repo/deps mapping, sibling-branch-aware dependency clones, source installs with[optional,docs]extras.Merge order: this PR merges FIRST — the PyAutoGalaxy/PyAutoLens caller PRs (PyAutoGalaxy#495-ish / PyAutoLens#597-ish, linked from #1341) reference
docs-build.yml@mainand their docs check errors until this lands.API Changes
None — CI infrastructure only, no Python surface.
Test Plan
docscheck goes green (Galaxy baseline 105, Lens 134, measured locally; if the CI count differs, recalibrate the baseline file once with justification — the job's error message documents this)Validation checklist (--auto run)
Full API Changes (for automation & release notes)
None — adds
.github/workflows/docs-build.yml(reusable workflow) only.🤖 Generated with Claude Code
https://claude.ai/code/session_01GziFkivBHz1d11eFYUszmy